// 《围棋》作者版权所有。版权所有。
// 此源代码的使用受BSD样式
// 许可证的约束，该许可证可以在许可证文件中找到。

// GC检查标记
// 
// 在并发垃圾收集器中，人们担心由于
// 活动对象。作为一种健全性检查，GC有一个“checkmark”
// 收集器实现中没有写障碍或错误的突变而无法标记
// 模式，该模式在世界停止时重新遍历对象图，以确保所有应该标记的内容都已标记。

package runtime

import (
	"runtime/internal/atomic"
	"runtime/internal/sys"
	"unsafe"
)

// checkmarks映射以“checkmarks”模式存储GC标记。这是一个
// 每个竞技场位图，竞技场中的每个单词都有一个位。标记
// 存储在标记
// 分配的第一个字对应的位上。
// 
// go:notinheap 
type checkmarksMap [heapArenaBytes / sys.PtrSize / 8]uint8

// 如果useCheckmark为true，则对象的标记使用复选标记
// 位，而不是标准标记位。
var useCheckmark = false

// 开始检查标记准备检查标记阶段。世界必须被阻止。
func startCheckmarks() {
	assertWorldStopped()

	// 清除所有复选标记。
	for _, ai := range mheap_.allArenas {
		arena := mheap_.arenas[ai.l1()][ai.l2()]
		bitmap := arena.checkmarks

		if bitmap == nil {
			// 第一次使用时分配位图。
			bitmap = (*checkmarksMap)(persistentalloc(unsafe.Sizeof(*bitmap), 0, &memstats.gcMiscSys))
			if bitmap == nil {
				throw("out of memory allocating checkmarks bitmap")
			}
			arena.checkmarks = bitmap
		} else {
			// 否则清除现有位图。
			for i := range bitmap {
				bitmap[i] = 0
			}
		}
	}
	// 启用选中标记。
	useCheckmark = true
}

// 结束复选标记阶段。
func endCheckmarks() {
	if gcMarkWorkAvailable(nil) {
		throw("GC work not flushed")
	}
	useCheckmark = false
}

// 如果标记对象违反了复选标记，则抛出setCheckmark，否则设置obj的复选标记。如果obj是
// 已选中，则返回true。
func setCheckmark(obj, base, off uintptr, mbits markBits) bool {
	if !mbits.isMarked() {
		printlock()
		print("runtime: checkmarks found unexpected unmarked object obj=", hex(obj), "\n")
		print("runtime: found obj at *(", hex(base), "+", hex(off), ")\n")

		// 转储源（基）对象
		gcDumpObject("base", base, off)

		// 转储对象
		gcDumpObject("obj", obj, ^uintptr(0))

		getg().m.traceback = 2
		throw("checkmark found unmarked object")
	}

	ai := arenaIndex(obj)
	arena := mheap_.arenas[ai.l1()][ai.l2()]
	arenaWord := (obj / heapArenaBytes / 8) % uintptr(len(arena.checkmarks))
	mask := byte(1 << ((obj / heapArenaBytes) % 8))
	bytep := &arena.checkmarks[arenaWord]

	if atomic.Load8(bytep)&mask != 0 {
		// 已选中。
		return true
	}

	atomic.Or8(bytep, mask)
	return false
}
